Data - Get customers list

GET 
/v1/customers

Get the list of customers created or updated between two dates.

Request

Query Parameters

groupUuid stringrequired

group uuid that needs to be considered for filter

startDate stringrequired

start date that needs to be considered for filter

endDate stringrequired

end date that needs to be considered for filter

limit number

Possible values: <= 10000

limit of the number of customers to return (default to 100)

page number

customers page to return (default to 1)

Responses

200

Successful

*/*

Schema

Schema

data string[]required

List of customers uuids

totalCount numberrequired

Total number of matching customers uuids

page numberrequired

Current page number

limit numberrequired

Maximum size of the page

Example (from schema)

{
  "data": [
    "3fa85f64-5717-4562-b3fc-2c963f66afb4"
  ],
  "totalCount": 1,
  "page": 1,
  "limit": 100
}

401

Unauthorized

*/*

Schema

Schema

data object
error string

Possible values: [Unauthorized]

statusCode number

Possible values: [401]

Example (from schema)

{
  "data": {},
  "error": "Unauthorized",
  "statusCode": 401
}

Loading...